package w.z.x.framework.repository.annotations;

import java.lang.annotation.*;

/**
 * 实体与存储映射关系
 *
 * @author 魏祖潇
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface Mapper {

    /**
     * 名称
     *
     * @return 名称
     */
    String value() default "";

    /**
     * 备注
     * @return 备注
     */
    String comment() default "";

    /**
     * 是否下划线格式
     * @return 是否下划线格式，默认true
     */
    boolean underline() default true;

    /**
     * 是否只读
     * @return 是否只读，默认false
     */
    boolean readOnly() default false;
}